/*
 *   Clovis
 *   Copyright (C) 2008 SFWOL
 *
 *   This program is free software: you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation, either version 3 of the License, or
 *   any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef __CLOVIS_VARIABLE_H
#define __CLOVIS_VARIABLE_H

#include <iostream>

namespace clovis {

	namespace core {

		/*!
		 * \brief The base class for all complex classes used in Clovis
		 *
		 * A very simple class who define a 'name' for every extended class
		 */
		class ClovisVariable {

            private:

                std::string name;

            public:

                /*!
                 * Create a new instance of ClovisVariable.
                 * \arg name Name of the new ClovisVariable.
                 */
                ClovisVariable(std::string name = "__noname__");

                virtual ~ClovisVariable();

				/*!
				 * Return the name of the current instance of ClovisVariable.
				 * \return The name of the ClovisVariable.
				 */
                std::string getName();

				/*!
				 * Get The class type in a std::string variable.
				 * THIS METHOD MUST BE IMPLEMENTED IN EVERY DERIVATED CLASS !
				 */
                virtual std::string getClass() = 0;

		};

	};

};

#endif
